-
Notifications
You must be signed in to change notification settings - Fork 155
Add comprehensive documentation for ExecutableResource and AddExecutable API #4188
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Co-authored-by: IEvangelist <[email protected]>
ExecutableResource
…zure SWA CLI with Vercel CLI Co-authored-by: IEvangelist <[email protected]>
…cument Co-authored-by: IEvangelist <[email protected]>
…meters section, correct AddExecutable parameter order, and update examples Co-authored-by: IEvangelist <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds comprehensive documentation for the ExecutableResource
and AddExecutable
API in .NET Aspire, filling a significant gap in the documentation. The new guide provides developers with clear instructions on how to host external executable applications within their Aspire app hosts.
Key changes:
- New comprehensive documentation article covering
ExecutableResource
andAddExecutable
usage - Practical examples including Vercel CLI integration and resource dependency management
- Publishing guidance with
PublishAsDockerfile
for production deployment - Table of contents entry for discoverability
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
File | Description |
---|---|
docs/app-host/executable-resources.md | New comprehensive documentation article covering ExecutableResource API usage, examples, and best practices |
docs/toc.yml | Added table of contents entry for the new executable resources documentation |
Co-authored-by: IEvangelist <[email protected]>
… Style Guide Co-authored-by: IEvangelist <[email protected]>
Co-authored-by: adegeo <[email protected]>
Co-authored-by: adegeo <[email protected]>
This PR adds a new comprehensive article documenting how to use
ExecutableResource
and theAddExecutable
extension method in .NET Aspire app hosts. The documentation was missing entirely, leaving developers without guidance on how to host external executable applications.What's included
The new article
docs/app-host/executable-resources.md
covers:AddExecutable
with command-line arguments and working directoriesAddExecutable
methodWithReference
calls and automatic connection string injectionPublishAsDockerfile
for deploymentKey examples
The article includes practical examples for common scenarios:
The documentation addresses the specific use case mentioned in the issue (external executable hosting) while providing comprehensive coverage for any external executable scenario using modern tooling like Vercel CLI.
Important: All examples correctly use the
AddExecutable
API signature where arguments are passed asparams string[] args
directly to the method. There is noWithArgs()
method available onExecutableResource
.Fixes #1381.
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.
Internal previews